Extension point caches

In component org.nuxeo.ecm.core.cache.CacheService

Documentation

Extension Point to define a new cache . 20

The class attribute may specify a class that implements the CacheManagement interface. The default implementation 'org.nuxeo.ecm.core.cache.InMemoryCacheImpl' is based on Google Guava.

The max size set the max number of elements contained in the cache

The Time To Live define in minutes the time before the cache will be destroyed

The concurrency level, number of thread that can access at the same time the cache

Contribution Descriptors

Class: org.nuxeo.ecm.core.cache.CacheDescriptor

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

<extension point="caches" target="org.nuxeo.ecm.core.cache.CacheService">
    <cache name="default-cache">
      <ttl>20</ttl><!-- minutes -->
      <option name="maxSize">10000</option>
      <option name="concurrencyLevel">500</option>
    </cache>

    <cache name="user-entry-cache">
      <option name="maxSize">10000</option>
      <ttl>20</ttl><!-- minutes -->
      <option name="concurrencyLevel">500</option>
    </cache>

    <cache name="user-entry-cache-without-references">
      <option name="maxSize">10000</option>
      <ttl>20</ttl><!-- minutes -->
      <option name="concurrencyLevel">500</option>
    </cache>

    <cache name="group-entry-cache">
      <option name="maxSize">10000</option>
      <ttl>20</ttl><!-- minutes -->
      <option name="concurrencyLevel">500</option>
    </cache>

    <cache name="group-entry-cache-without-references">
      <option name="maxSize">10000</option>
      <ttl>20</ttl><!-- minutes -->
      <option name="concurrencyLevel">500</option>
    </cache>

    <cache name="digestauth-entry-cache">
      <option name="maxSize">10000</option>
      <ttl>20</ttl><!-- minutes -->
      <option name="concurrencyLevel">500</option>
    </cache>

    <cache name="digestauth-entry-cache-without-references">
      <option name="maxSize">10000</option>
      <ttl>20</ttl><!-- minutes -->
      <option name="concurrencyLevel">500</option>
    </cache>

    <cache name="ldap-user-entry-cache">
      <option name="maxSize">10000</option>
      <ttl>20</ttl><!-- minutes -->
      <option name="concurrencyLevel">500</option>
    </cache>

    <cache name="ldap-user-entry-cache-without-references">
      <option name="maxSize">10000</option>
      <ttl>20</ttl><!-- minutes -->
      <option name="concurrencyLevel">500</option>
    </cache>

    <cache name="ldap-group-entry-cache">
      <option name="maxSize">10000</option>
      <ttl>20</ttl><!-- minutes -->
      <option name="concurrencyLevel">500</option>
    </cache>

    <cache name="ldap-group-entry-cache-without-references">
      <option name="maxSize">10000</option>
      <ttl>20</ttl><!-- minutes -->
      <option name="concurrencyLevel">500</option>
    </cache>

  </extension>

(0) nuxeo-runtime-2023.10.13.jar/opt/nuxeo/server/nxserver/config/cache-config.xml Override

<extension point="caches" target="org.nuxeo.ecm.core.cache.CacheService">

    <cache name="box">
      <option name="maxSize">1000</option>
      <option name="concurrencyLevel">10</option>
      <ttl>60</ttl>
    </cache>

  </extension>

(1) nuxeo-liveconnect-2023.10.13.jar/OSGI-INF/liveconnect-box-cache-config.xml Override

<extension point="caches" target="org.nuxeo.ecm.core.cache.CacheService">

    <cache name="googleDrive">
      <option name="maxSize">1000</option>
      <option name="concurrencyLevel">10</option>
      <ttl>60</ttl>
    </cache>

  </extension>

(2) nuxeo-liveconnect-2023.10.13.jar/OSGI-INF/liveconnect-googledrive-cache-config.xml Override

<extension point="caches" target="org.nuxeo.ecm.core.cache.CacheService">

    <cache name="tenants-cache">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
    </cache>

    <cache name="tenants-cache-without-ref">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
    </cache>

    <cache name="topic-cache-without-ref">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
    </cache>

    <cache name="topic-cache">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
    </cache>

    <cache name="subtopic-cache-without-ref">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
    </cache>

    <cache name="subtopic-cache">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
    </cache>

    <cache name="l10nsubjects-cache-without-ref">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
    </cache>

    <cache name="l10nsubjects-cache">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
    </cache>

    <cache name="l10ncoverage-cache-without-ref">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
    </cache>

    <cache name="l10ncoverage-cache">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
    </cache>


  </extension>

(3) nuxeo-multi-tenant-core-2023.10.13.jar/OSGI-INF/directories-cache-contrib.xml Override

<extension point="caches" target="org.nuxeo.ecm.core.cache.CacheService">

    <cache name="cache-vocabulary">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
      <option name="concurrencyLevel">10</option>
    </cache>

    <cache name="cache-xvocabulary">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
      <option name="concurrencyLevel">10</option>
    </cache>

    <cache name="cache-l10nxvocabulary">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
      <option name="concurrencyLevel">10</option>
    </cache>

    <cache name="cache-documentsLists">
      <ttl>60</ttl><!-- minutes -->
      <option name="maxSize">1000</option>
      <option name="concurrencyLevel">10</option>
    </cache>

  </extension>

(4) nuxeo-platform-default-config-2023.10.13.jar/OSGI-INF/default-cache-contrib.xml Override

<extension point="caches" target="org.nuxeo.ecm.core.cache.CacheService">

    <cache name="userDisplayName">
      <option name="maxSize">1000</option>
      <option name="concurrencyLevel">10</option>
      <ttl>30</ttl>
    </cache>

  </extension>

(5) nuxeo-platform-ui-web-2023.10.13.jar/OSGI-INF/username-cache-config.xml Override

<extension point="caches" target="org.nuxeo.ecm.core.cache.CacheService">

    <cache name="workflowModels">
      <ttl>10</ttl><!-- minutes -->
      <option name="maxSize">100</option>
    </cache>

  </extension>

(6) nuxeo-routing-core-2023.10.13.jar/OSGI-INF/document-routing-cache-contrib.xml Override

<extension point="caches" target="org.nuxeo.ecm.core.cache.CacheService">
    <cache name="vocab-WorkflowType-cache">
      <option name="maxSize">1000</option>
      <option name="concurrencyLevel">500</option>
      <ttl>60</ttl>
    </cache>
    <cache name="vocab-WorkflowType-cache-without-references">
      <option name="maxSize">1000</option>
      <option name="concurrencyLevel">500</option>
      <ttl>60</ttl>
    </cache>
  </extension>

(7) nuxeo-routing-default-2023.10.13.jar/OSGI-INF/extensions.xml Override